home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / hash / RCS / Hash_PrintStats.man,v < prev    next >
Text File  |  1988-12-30  |  2KB  |  75 lines
  1. head     1.1;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.1
  10. date     88.12.30.15.05.25;  author ouster;  state Exp;
  11. branches ;
  12. next     ;
  13.  
  14.  
  15. desc
  16. @@
  17.  
  18.  
  19.  
  20. 1.1
  21. log
  22. @Initial revision
  23. @
  24. text
  25. @' $Header: Hash_PrintStats,v 1.1 86/11/19 17:13:04 ouster Exp $ SPRITE (Berkeley)
  26. .so \*(]ltmac.sprite
  27. .HS Hash_PrintStats lib
  28. .BS
  29. .SH NAME
  30. Hash_PrintStats \- print statistics about a hash table 
  31. .SH SYNOPSIS
  32. \fB#include <hash.h>\fR
  33. .sp
  34. \fBHash_PrintStats\fR(\fItablePtr, proc, clientData\fR)
  35. .AS ClientData clientData
  36. .SH ARGUMENTS
  37. .AP Hash_Table *tablePtr in
  38. Table about which to print information.
  39. .AP void (*proc)() in
  40. Procedure to call to actually print information.
  41. .AP ClientData clientData in
  42. Arbitrary additional argument to be passed to \fIproc\fP.
  43. .BE
  44.  
  45. .SH DESCRIPTION
  46. .LP
  47. \fBHash_PrintStats\fR prints out statistical information about bucket
  48. usage in \fItablePtr\fP.  The information includes the total number
  49. of buckets and entries in the table, plus a histogram indicating
  50. how many buckets have each different number of entries in them.
  51. .LP
  52. \fBHash_PrintStats\fR does not output the statistics information directly.
  53. Instead, it invokes \fIproc\fP to do the output.  Proc must
  54. have the following calling sequence:
  55. .DS
  56. .ta 1c 2c 3c
  57. void
  58. proc(\fIclientData, string\fP)
  59.     ClientData \fIclientData\fP;
  60.     char *\fIstring\fP;
  61. {
  62. }
  63. .DE
  64. .LP
  65. The \fIclientData\fP parameter will be the same as the \fIclientData\fP
  66. to \fBHash_PrintStats\fR;  ostensibly it provides information to help \fIproc\fP
  67. perform the actual I/O, such as channel number.  \fIString\fP is
  68. a NULL-terminated string of characters containing the statistical
  69. information.  \fIProc\fP may be invoked many times during a single
  70. call to \fBHash_PrintStats\fR.
  71.  
  72. .SH KEYWORDS
  73. hash table, print, statistics
  74. @
  75.